Get SMS Delivery Notification

This API is used to retrieve SMS delivery status.

HTTP URL
GET	api/v2/subscriber/{type}/{value}/sms/{id}}

NOTE: {id} is the notification ID received when sending text or binary SMS. All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

API Request

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
notification	String	M	SMS delivery notification Range: 200: OK 202: Accepted 204: No Content 500: Server Error 408: Request Timeout
deliveryTime	DateTime	O	SMS delivery timestamp. If the SMS was not yet delivered, it will be empty.

Element

Type

M/O/CM

Description

notification

String

SMS delivery notification

Range:

200: OK

202: Accepted

204: No Content

500: Server Error

408: Request Timeout

deliveryTime

DateTime

SMS delivery timestamp. If the SMS was not yet delivered, it will be empty.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
GLOBAL_1004	SMS notification ID was not found

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
    "errorCode": null,
    "errorMessage": null,
    "content": [
        {
            "notification": "success",
              "deliveryTime": "2023-11-29T08:49:28.960Z"
        }
    ],
    "pageable": null
}

Response Body: Failure NAK

Copy

{
  "errorCode": "GLOBAL_1004",
  "errorMessage": "SMS notification ID was not found",
  "content": "",
  "pageable": ""
}